package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.CrmVisitRecordAddDTO;
import org.jsola.hr.dto.CrmVisitRecordUpdateDTO;
import org.jsola.hr.query.CrmVisitRecordQuery;
import org.jsola.hr.vo.CrmVisitRecordListVO;
import org.jsola.hr.vo.CrmVisitRecordVO;

import java.util.List;

/**
 * 拜访记录表
 *
 * @author zhr
 */
@Api(tags = "hr-拜访记录表")
public interface ICrmVisitRecordControllerAPI {

    /**
     * 新增拜访记录表
     * @param crmVisitRecordAddDTO 拜访记录表新增实体
     * @return 拜访记录表展示对象
     */
    @ApiOperation(value = "新增拜访记录表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmVisitRecordAddDTO", dataType = "CrmVisitRecordAddDTO", value = "新增拜访记录表", paramType = "body")
    })
    Result<CrmVisitRecordVO> save(CrmVisitRecordAddDTO crmVisitRecordAddDTO);


    /**
     * 修改拜访记录表
     * @param crmVisitRecordUpdateDTO 拜访记录表
     * @return 更新数量
     */
    @ApiOperation(value = "修改拜访记录表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmVisitRecordUpdateDTO", dataType = "CrmVisitRecordUpdateDTO", value = "修改拜访记录表", paramType = "body")
    })
    Result<Integer> update(CrmVisitRecordUpdateDTO crmVisitRecordUpdateDTO);




    /**
     * 删除单个拜访记录表，彻底删除
     * @param crmVisitRecordId 拜访记录表id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个拜访记录表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmVisitRecordId", dataType = "String", value = "拜访记录表id", paramType = "path")
    })
    Result<Integer> delete(String crmVisitRecordId);


    /**
     * 批量删除拜访记录表，彻底删除
     * @param crmVisitRecordIds 拜访记录表id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除拜访记录表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmVisitRecordIds", dataType = "String[]", value = "拜访记录表id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] crmVisitRecordIds);


    /**
     * 根据拜访记录表id查询拜访记录表详情
     * @param crmVisitRecordId 拜访记录表id
     * @return 拜访记录表详情
     */
    @ApiOperation(value="根据拜访记录表id查询拜访记录表详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmVisitRecordId", dataType = "String", value = "拜访记录表id", paramType = "path")
    })
    Result<CrmVisitRecordVO> findById(String crmVisitRecordId);


    /**
     * 查询拜访记录表
     * @param crmVisitRecordQuery 拜访记录表查询参数
     * @return page
     */
    @ApiOperation(value="查询拜访记录表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmVisitRecordQuery", dataType = "CrmVisitRecordQuery", value = "拜访记录表查询参数", paramType = "query")
    })
    Result<List<CrmVisitRecordListVO>> listAll(CrmVisitRecordQuery crmVisitRecordQuery);


     /**
     * 分页查询拜访记录表
     * @param crmVisitRecordQuery 拜访记录表查询参数
     * @return page
     */
    @ApiOperation(value="分页查询拜访记录表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "crmVisitRecordQuery", dataType = "CrmVisitRecordQuery", value = "拜访记录表查询参数", paramType = "query")
    })
    Result<Page<CrmVisitRecordListVO>> page(CrmVisitRecordQuery crmVisitRecordQuery);


}

